Ci/fix update versionned docs #501
Conversation
WalkthroughThe recent updates to the GitHub workflows are aimed at refining the version bump process and enhancing the flexibility of documentation updates. Specifically, a typo in the commit message for bumping the "axoned" version was corrected. Additionally, the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (2)
.github/workflows/bump-axoned-version.yml (1)
Line range hint
28-35: Security Improvement: Avoid direct interpolation of GitHub context variables in scripts.- jq '.axonedVersion |= "${{ github.event.inputs.axonedVersion }}"' "$dataFile" > "$tmpFile" && + env: + AXONED_VERSION: ${{ github.event.inputs.axonedVersion }} + run: | + jq '.axonedVersion |= "$AXONED_VERSION"' "$dataFile" > "$tmpFile" &&.github/workflows/update-versioned-docs.yml (1)
Line range hint
57-63: Security Improvement: Avoid direct interpolation of GitHub context variables in scripts.- rm -rf ${{ github.event.inputs.section }}/* + env: + SECTION: ${{ github.event.inputs.section }} + run: | + rm -rf "$SECTION"/*
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- .github/workflows/bump-axoned-version.yml (1 hunks)
- .github/workflows/update-versioned-docs.yml (2 hunks)
Additional comments not posted (3)
.github/workflows/bump-axoned-version.yml (1)
42-42: The updated commit message correctly includes the dynamic version number..github/workflows/update-versioned-docs.yml (2)
4-5: Concurrency settings have been effectively updated to handle different sections independently.
17-17: The input description update to include "predicates" is accurate and aligns with the PR objectives.
There was a problem hiding this comment.
| Device | URL |
|---|---|
| desktop | http://localhost:3000/ |
| Device | URL |
|---|---|
| mobile | http://localhost:3000/ |
Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead
This PR introduces several fixes and improvements:
Corrected a typographical error in the commit message that is sent when a new version of the documentation is pushed.
Addressed a perceived concurrency issue which should have been fixed by 🐛 ci: fix concurrency group for publish new docs version #498. This was not an actual issue, but rather a feature of GitHub Actions where pending workflows with the same group ID are cancelled when
cancel-in-progressis set tofalse. A request has been made to the GitHub community in 2022 to add a new parametercancel-pendingthat would allow pending workflows to wait instead of being cancelled. More details can be found here.As a workaround, the
sectionname has been added to the group ID, allowing one section to be built at a time. Since no common file is edited when publishing a new version of the documentation for each section, and changes are introduced via PRs rather than direct pushes, this should not cause any issues. Additionally,cancel-in-progresshas been set back totruefor drafts, with the section linked through the group ID.Added the
predicatessection to the input examples.Summary by CodeRabbit